<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Copyright (C) 2007 The Guava Authors<a name="line.2"></a>
<span class="sourceLineNo">003</span> *<a name="line.3"></a>
<span class="sourceLineNo">004</span> * Licensed under the Apache License, Version 2.0 (the "License");<a name="line.4"></a>
<span class="sourceLineNo">005</span> * you may not use this file except in compliance with the License.<a name="line.5"></a>
<span class="sourceLineNo">006</span> * You may obtain a copy of the License at<a name="line.6"></a>
<span class="sourceLineNo">007</span> *<a name="line.7"></a>
<span class="sourceLineNo">008</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * Unless required by applicable law or agreed to in writing, software<a name="line.10"></a>
<span class="sourceLineNo">011</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.11"></a>
<span class="sourceLineNo">012</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.12"></a>
<span class="sourceLineNo">013</span> * See the License for the specific language governing permissions and<a name="line.13"></a>
<span class="sourceLineNo">014</span> * limitations under the License.<a name="line.14"></a>
<span class="sourceLineNo">015</span> */<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>package com.google.common.collect;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import com.google.common.annotations.GwtCompatible;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.Map;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.Set;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>import javax.annotation.Nullable;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>/**<a name="line.26"></a>
<span class="sourceLineNo">027</span> * A bimap (or "bidirectional map") is a map that preserves the uniqueness of<a name="line.27"></a>
<span class="sourceLineNo">028</span> * its values as well as that of its keys. This constraint enables bimaps to<a name="line.28"></a>
<span class="sourceLineNo">029</span> * support an "inverse view", which is another bimap containing the same entries<a name="line.29"></a>
<span class="sourceLineNo">030</span> * as this bimap but with reversed keys and values.<a name="line.30"></a>
<span class="sourceLineNo">031</span> * <a name="line.31"></a>
<span class="sourceLineNo">032</span> * &lt;p&gt;See the Guava User Guide article on &lt;a href=<a name="line.32"></a>
<span class="sourceLineNo">033</span> * "http://code.google.com/p/guava-libraries/wiki/NewCollectionTypesExplained#BiMap"&gt;<a name="line.33"></a>
<span class="sourceLineNo">034</span> * {@code BiMap}&lt;/a&gt;.<a name="line.34"></a>
<span class="sourceLineNo">035</span> *<a name="line.35"></a>
<span class="sourceLineNo">036</span> * @author Kevin Bourrillion<a name="line.36"></a>
<span class="sourceLineNo">037</span> * @since 2.0 (imported from Google Collections Library)<a name="line.37"></a>
<span class="sourceLineNo">038</span> */<a name="line.38"></a>
<span class="sourceLineNo">039</span>@GwtCompatible<a name="line.39"></a>
<span class="sourceLineNo">040</span>public interface BiMap&lt;K, V&gt; extends Map&lt;K, V&gt; {<a name="line.40"></a>
<span class="sourceLineNo">041</span>  // Modification Operations<a name="line.41"></a>
<span class="sourceLineNo">042</span><a name="line.42"></a>
<span class="sourceLineNo">043</span>  /**<a name="line.43"></a>
<span class="sourceLineNo">044</span>   * {@inheritDoc}<a name="line.44"></a>
<span class="sourceLineNo">045</span>   *<a name="line.45"></a>
<span class="sourceLineNo">046</span>   * @throws IllegalArgumentException if the given value is already bound to a<a name="line.46"></a>
<span class="sourceLineNo">047</span>   *     different key in this bimap. The bimap will remain unmodified in this<a name="line.47"></a>
<span class="sourceLineNo">048</span>   *     event. To avoid this exception, call {@link #forcePut} instead.<a name="line.48"></a>
<span class="sourceLineNo">049</span>   */<a name="line.49"></a>
<span class="sourceLineNo">050</span>  @Override<a name="line.50"></a>
<span class="sourceLineNo">051</span>  V put(@Nullable K key, @Nullable V value);<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span>  /**<a name="line.53"></a>
<span class="sourceLineNo">054</span>   * An alternate form of {@code put} that silently removes any existing entry<a name="line.54"></a>
<span class="sourceLineNo">055</span>   * with the value {@code value} before proceeding with the {@link #put}<a name="line.55"></a>
<span class="sourceLineNo">056</span>   * operation. If the bimap previously contained the provided key-value<a name="line.56"></a>
<span class="sourceLineNo">057</span>   * mapping, this method has no effect.<a name="line.57"></a>
<span class="sourceLineNo">058</span>   *<a name="line.58"></a>
<span class="sourceLineNo">059</span>   * &lt;p&gt;Note that a successful call to this method could cause the size of the<a name="line.59"></a>
<span class="sourceLineNo">060</span>   * bimap to increase by one, stay the same, or even decrease by one.<a name="line.60"></a>
<span class="sourceLineNo">061</span>   *<a name="line.61"></a>
<span class="sourceLineNo">062</span>   * &lt;p&gt;&lt;b&gt;Warning:&lt;/b&gt; If an existing entry with this value is removed, the key<a name="line.62"></a>
<span class="sourceLineNo">063</span>   * for that entry is discarded and not returned.<a name="line.63"></a>
<span class="sourceLineNo">064</span>   *<a name="line.64"></a>
<span class="sourceLineNo">065</span>   * @param key the key with which the specified value is to be associated<a name="line.65"></a>
<span class="sourceLineNo">066</span>   * @param value the value to be associated with the specified key<a name="line.66"></a>
<span class="sourceLineNo">067</span>   * @return the value which was previously associated with the key, which may<a name="line.67"></a>
<span class="sourceLineNo">068</span>   *     be {@code null}, or {@code null} if there was no previous entry<a name="line.68"></a>
<span class="sourceLineNo">069</span>   */<a name="line.69"></a>
<span class="sourceLineNo">070</span>  V forcePut(@Nullable K key, @Nullable V value);<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span>  // Bulk Operations<a name="line.72"></a>
<span class="sourceLineNo">073</span><a name="line.73"></a>
<span class="sourceLineNo">074</span>  /**<a name="line.74"></a>
<span class="sourceLineNo">075</span>   * {@inheritDoc}<a name="line.75"></a>
<span class="sourceLineNo">076</span>   *<a name="line.76"></a>
<span class="sourceLineNo">077</span>   * &lt;p&gt;&lt;b&gt;Warning:&lt;/b&gt; the results of calling this method may vary depending on<a name="line.77"></a>
<span class="sourceLineNo">078</span>   * the iteration order of {@code map}.<a name="line.78"></a>
<span class="sourceLineNo">079</span>   *<a name="line.79"></a>
<span class="sourceLineNo">080</span>   * @throws IllegalArgumentException if an attempt to {@code put} any<a name="line.80"></a>
<span class="sourceLineNo">081</span>   *     entry fails. Note that some map entries may have been added to the<a name="line.81"></a>
<span class="sourceLineNo">082</span>   *     bimap before the exception was thrown.<a name="line.82"></a>
<span class="sourceLineNo">083</span>   */<a name="line.83"></a>
<span class="sourceLineNo">084</span>  @Override<a name="line.84"></a>
<span class="sourceLineNo">085</span>  void putAll(Map&lt;? extends K, ? extends V&gt; map);<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span>  // Views<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span>  /**<a name="line.89"></a>
<span class="sourceLineNo">090</span>   * {@inheritDoc}<a name="line.90"></a>
<span class="sourceLineNo">091</span>   *<a name="line.91"></a>
<span class="sourceLineNo">092</span>   * &lt;p&gt;Because a bimap has unique values, this method returns a {@link Set},<a name="line.92"></a>
<span class="sourceLineNo">093</span>   * instead of the {@link java.util.Collection} specified in the {@link Map}<a name="line.93"></a>
<span class="sourceLineNo">094</span>   * interface.<a name="line.94"></a>
<span class="sourceLineNo">095</span>   */<a name="line.95"></a>
<span class="sourceLineNo">096</span>  @Override<a name="line.96"></a>
<span class="sourceLineNo">097</span>  Set&lt;V&gt; values();<a name="line.97"></a>
<span class="sourceLineNo">098</span><a name="line.98"></a>
<span class="sourceLineNo">099</span>  /**<a name="line.99"></a>
<span class="sourceLineNo">100</span>   * Returns the inverse view of this bimap, which maps each of this bimap's<a name="line.100"></a>
<span class="sourceLineNo">101</span>   * values to its associated key. The two bimaps are backed by the same data;<a name="line.101"></a>
<span class="sourceLineNo">102</span>   * any changes to one will appear in the other.<a name="line.102"></a>
<span class="sourceLineNo">103</span>   *<a name="line.103"></a>
<span class="sourceLineNo">104</span>   * &lt;p&gt;&lt;b&gt;Note:&lt;/b&gt;There is no guaranteed correspondence between the iteration<a name="line.104"></a>
<span class="sourceLineNo">105</span>   * order of a bimap and that of its inverse.<a name="line.105"></a>
<span class="sourceLineNo">106</span>   *<a name="line.106"></a>
<span class="sourceLineNo">107</span>   * @return the inverse view of this bimap<a name="line.107"></a>
<span class="sourceLineNo">108</span>   */<a name="line.108"></a>
<span class="sourceLineNo">109</span>  BiMap&lt;V, K&gt; inverse();<a name="line.109"></a>
<span class="sourceLineNo">110</span>}<a name="line.110"></a>




























































</pre>
</div>
</body>
</html>
